home *** CD-ROM | disk | FTP | other *** search
/ Aminet 49 / Aminet 49 (2002)(GTI - Schatztruhe)[!][Jun 2002].iso / Aminet / text / misc / htmldoc.lha / man / man1 / htmldoc.1
Encoding:
Text File  |  2002-04-18  |  13.9 KB  |  500 lines
  1. htmldoc(1)            Easy Software Products           htmldoc(1)
  2.  
  3.  
  4.  
  5. NNAAMMEE
  6.        htmldoc - convert html source files into html, postscript,
  7.        or pdf.
  8.  
  9.  
  10. SSYYNNOOPPSSIISS
  11.        htmldoc [options] filename1.html [ ... filenameN.html ]
  12.  
  13.        htmldoc [options] -
  14.  
  15.        htmldoc [filename.book]
  16.  
  17.  
  18. DDEESSCCRRIIPPTTIIOONN
  19.        _H_T_M_L_D_O_C converts HTML  source  files  into  indexed  HTML,
  20.        PostScript,  or  Portable Document Format (PDF) files that
  21.        can be viewed online or printed.  With no  options  a  PDF
  22.        document is produced on stdout.
  23.  
  24.        The  second  form of _H_T_M_L_D_O_C reads HTML source from stdin,
  25.        which allows you to use _H_T_M_L_D_O_C as a filter.
  26.  
  27.        The third form of _H_T_M_L_D_O_C launches a  graphical  interface
  28.        that  allows  you to change options and generate documents
  29.        interactively.
  30.  
  31. CCOOMMMMOONN MMIISSTTAAKKEESS
  32.        There are two types of HTML files -  structured  documents
  33.        using headings (H1, H2, etc.) which _H_T_M_L_D_O_C calls "books",
  34.        and unstructured documents that do not use headings  which
  35.        _H_T_M_L_D_O_C calls "web pages".
  36.  
  37.        A  very  common  mistake  is  to try converting a web page
  38.        using:
  39.  
  40.        htmldoc -f filename.pdf filename.html
  41.  
  42.        which will likely produce a PDF file  with  no  pages.  To
  43.        convert  web  page  files  you  mmuusstt  use the _-_-_w_e_b_p_a_g_e or
  44.        _-_-_c_o_n_t_i_n_u_o_u_s options at the  command-line  or  choose  _W_e_b
  45.        _P_a_g_e or _C_o_n_t_i_n_u_o_u_s in the input tab of the GUI.
  46.  
  47. OOPPTTIIOONNSS
  48.        The  following command-line options are supported by _H_T_M_L_-
  49.        _D_O_C:
  50.  
  51.  
  52.        --batch _f_i_l_e_n_a_m_e_._b_o_o_k
  53.             Generates the specified book file without opening the
  54.             GUI.
  55.  
  56.  
  57.        --bodycolor _c_o_l_o_r
  58.             Specifies the background color for all pages.
  59.  
  60.  
  61.        --bodyfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
  62.  
  63.        --textfont _{_c_o_u_r_i_e_r_,_t_i_m_e_s_,_h_e_l_v_e_t_i_c_a_}
  64.             Specifies the default typeface for all normal text.
  65.  
  66.  
  67.        --bodyimage _f_i_l_e_n_a_m_e
  68.             Specifies  the  background image that is tiled on all
  69.             pages.
  70.  
  71.  
  72.        --book
  73.             Specifies that the HTML sources are structured (head-
  74.             ings, chapters, etc.)
  75.  
  76.  
  77.        --bottom _m_a_r_g_i_n
  78.             Specifies  the  bottom margin in points (no suffix or
  79.             ##pt), inches (##in), centimeters (##cm), or millime-
  80.             ters (##mm).
  81.  
  82.  
  83.        --charset _{_8_8_5_9_-_1_._._._8_8_5_9_-_1_5_}
  84.             Specifies  the  ISO character set to use for the out-
  85.             put.
  86.  
  87.  
  88.        --color
  89.             Specifies that PostScript or PDF output should be  in
  90.             color.
  91.  
  92.  
  93.        --continuous
  94.             Specifies  that  the  HTML  sources  are unstructured
  95.             (plain web  pages.)   No  page  breaks  are  inserted
  96.             between each file or URL in the output.
  97.  
  98.  
  99.        --datadir _d_i_r_e_c_t_o_r_y
  100.             Specifies  the  location  of  the _H_T_M_L_D_O_C data files,
  101.             usually _/_u_s_r_/_s_h_a_r_e_/_h_t_m_l_d_o_c or _C_:_\_P_r_o_g_r_a_m  _F_i_l_e_s_\_H_T_M_L_-
  102.             _D_O_C.
  103.  
  104.  
  105.        --duplex
  106.             Specifies  that  the  output  should be formatted for
  107.             double-sided printing.
  108.  
  109.  
  110.        --effectduration _{ _0_._1_._._1_0_._0 _}
  111.             Specifies the duration in seconds of PDF page transi-
  112.             tion effects.
  113.  
  114.  
  115.        --encryption
  116.             Enables encryption of PDF files.
  117.  
  118.  
  119.        --fontsize _s_i_z_e
  120.             Specifies the default font size for body text.
  121.  
  122.  
  123.        --fontspacing _s_p_a_c_i_n_g
  124.             Specifies the default line spacing for body text. The
  125.             line spacing is a multiplier for the font size, so  a
  126.             value  of 1.2 will provide an additional 20% of space
  127.             between the lines.
  128.  
  129.  
  130.        --footer _f_f_f
  131.             Sets the page footer to use on body  pages.  See  the
  132.             _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  133.  
  134.  
  135.        --format _f_o_r_m_a_t
  136.  
  137.        -t _f_o_r_m_a_t
  138.             Specifies   the   output  format:  html,  ps  or  ps2
  139.             (PostScript Level 2), ps1 (PostScript Level  1),  ps3
  140.             (PostScript  Level  3),  pdf11 (PDF 1.1/Acrobat 2.0),
  141.             pdf12  (PDF  1.2/Acrobat  3.0),  pdf  or  pdf13  (PDF
  142.             1.3/Acrobat 4.0), or pdf14 (PDF 1.4/Acrobat 5.0).
  143.  
  144.  
  145.        --gray
  146.             Specifies  that  PostScript  or  PDF output should be
  147.             grayscale.
  148.  
  149.  
  150.        --header _f_f_f
  151.             Sets the page header to use on body  pages.  See  the
  152.             _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  153.  
  154.  
  155.        --headfootfont _f_o_n_t
  156.             Sets the font to use on headers and footers.
  157.  
  158.  
  159.        --headfootsize _s_i_z_e
  160.             Sets the size of the font to use on headers and foot-
  161.             ers.
  162.  
  163.  
  164.        --headingfont _t_y_p_e_f_a_c_e
  165.             Sets the typeface to use for headings.
  166.  
  167.  
  168.        --help
  169.             Displays a summary of command-line options.
  170.  
  171.  
  172.        --helpdir _d_i_r_e_c_t_o_r_y
  173.             Specifies the location of the  _H_T_M_L_D_O_C  on-line  help
  174.             files,  usually  _/_u_s_r_/_s_h_a_r_e_/_d_o_c_/_h_t_m_l_d_o_c or _C_:_\_P_r_o_g_r_a_m
  175.             _F_i_l_e_s_\_H_T_M_L_D_O_C_\_D_O_C.
  176.  
  177.  
  178.        --jpeg_[_=_q_u_a_l_i_t_y_]
  179.             Sets the JPEG compression  level  to  use  for  large
  180.             images. A value of 0 disables JPEG compression.
  181.  
  182.  
  183.        --left _m_a_r_g_i_n
  184.             Specifies  the  left  margin  in points (no suffix or
  185.             ##pt), inches (##in), centimeters (##cm), or millime-
  186.             ters (##mm).
  187.  
  188.  
  189.        --linkcolor _c_o_l_o_r
  190.             Sets the color of links.
  191.  
  192.  
  193.        --links
  194.             Enables generation of links in PDF files (default).
  195.  
  196.  
  197.        --linkstyle _{_p_l_a_i_n_,_u_n_d_e_r_l_i_n_e_}
  198.             Sets the style of links.
  199.  
  200.  
  201.        --logoimage _f_i_l_e_n_a_m_e
  202.             Specifies an image to be used as a logo in the header
  203.             or footer in a PostScript or PDF document, and in the
  204.             navigation bar of a HTML document.
  205.  
  206.  
  207.        --no-compression
  208.             Disables compression of PostScript or PDF files.
  209.  
  210.  
  211.        --no-duplex
  212.             Disables double-sided printing.
  213.  
  214.  
  215.        --no-encryption
  216.             Disables document encryption.
  217.  
  218.  
  219.        --no-jpeg
  220.             Disables JPEG compression of large images.
  221.  
  222.  
  223.        --no-links
  224.             Disables generation of links in a PDF document.
  225.  
  226.  
  227.        --no-numbered
  228.             Disables automatic heading numbering.
  229.  
  230.  
  231.        --no-pscommands
  232.             Disables  generation of PostScript setpagedevice com-
  233.             mands.
  234.  
  235.  
  236.        --no-title
  237.             Disables generation of a title page.
  238.  
  239.  
  240.        --no-toc
  241.             Disables generation of a table of contents.
  242.  
  243.  
  244.        --no-truetype
  245.             Disables use of TrueType fonts in PDF output.
  246.  
  247.  
  248.        --numbered
  249.             Numbers all headings in a document.
  250.  
  251.  
  252.        --outdir _d_i_r_e_c_t_o_r_y
  253.  
  254.        -d _d_i_r_e_c_t_o_r_y
  255.             Specifies that output should be sent to  a  directory
  256.             in multiple files.  (Not compatible with PDF output)
  257.  
  258.  
  259.        --outfile _f_i_l_e_n_a_m_e
  260.  
  261.        -f _f_i_l_e_n_a_m_e
  262.             Specifies  that  output  should  be  sent to a single
  263.             file.
  264.  
  265.  
  266.        --owner-password _p_a_s_s_w_o_r_d
  267.             Sets the owner password for encrypted PDF files.
  268.  
  269.  
  270.        --pageduration _{_1_._0_._._6_0_._0_}
  271.             Sets the view duration of a page in a PDF document.
  272.  
  273.  
  274.        --pageeffect _e_f_f_e_c_t
  275.             Specifies the page transition effect for  all  pages;
  276.             this attribute is ignored by all Adobe PDF viewers...
  277.  
  278.  
  279.        --pagelayout _{_s_i_n_g_l_e_,_o_n_e_,_t_w_o_l_e_f_t_,_t_w_o_r_i_g_h_t_}
  280.             Specifies the initial layout of pages for a PDF file.
  281.  
  282.  
  283.        --pagemode _{_d_o_c_u_m_e_n_t_,_o_u_t_l_i_n_e_s_,_f_u_l_l_s_c_r_e_e_n_}
  284.             Specifies the initial viewing mode for a PDF file.
  285.  
  286.  
  287.        --path
  288.             Specifies a search path for files in a document.
  289.  
  290.  
  291.        --permissions _p_e_r_m_i_s_s_i_o_n
  292.             Specifies  document  permissions  for  encrypted  PDF
  293.             files. Multiple _-_-_p_e_r_m_i_s_s_i_o_n_s options are required to
  294.             grant  or  deny  specific  permissions. The following
  295.             values are understood: all, none, annotate,  no-anno-
  296.             tate,  copy,  no-copy,  modify, no-modify, print, and
  297.             no-print.
  298.  
  299.  
  300.        --pscommands
  301.             Specifies  that  PostScript  setpagedevice   commands
  302.             should be included in the output.
  303.  
  304.  
  305.        --quiet
  306.             Suppresses all messages, even error messages.
  307.  
  308.  
  309.        --right _m_a_r_g_i_n
  310.             Specifies  the  right  margin in points (no suffix or
  311.             ##pt), inches (##in), centimeters (##cm), or millime-
  312.             ters (##mm).
  313.  
  314.  
  315.        --size _p_a_g_e_s_i_z_e
  316.             Specifies  the  page size using a standard name or in
  317.             points (no suffix or ##x##pt), inches (##x##in), cen-
  318.             timeters  (##x##cm),  or  millimeters  (##x##mm). The
  319.             standard sizes  that  are  currently  recognized  are
  320.             "letter"   (8.5x11in),   "legal"   (8.5x14in),   "a4"
  321.             (210x297mm), and "universal" (8.27x11in).
  322.  
  323.  
  324.        --textcolor _c_o_l_o_r
  325.             Specifies the default color of all text.
  326.  
  327.  
  328.        --title
  329.             Enables the generation of a title page.
  330.  
  331.  
  332.        --titlefile _f_i_l_e_n_a_m_e
  333.  
  334.        --titleimage _f_i_l_e_n_a_m_e
  335.             Specifies the file to use for the title page. If  the
  336.             file is an image then the title page is automatically
  337.             generated using the  document  meta  data  and  title
  338.             image.
  339.  
  340.  
  341.        --tocfooter _f_f_f
  342.             Sets  the  page  footer  to  use on table-of-contents
  343.             pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  344.  
  345.  
  346.        --tocheader _f_f_f
  347.             Sets  the  page  header  to  use on table-of-contents
  348.             pages. See the _H_E_A_D_E_R_S_/_F_O_O_T_E_R_S _F_O_R_M_A_T_S section below.
  349.  
  350.  
  351.        --toclevels _l_e_v_e_l_s
  352.             Sets the number of levels in the table-of-contents.
  353.  
  354.  
  355.        --toctitle _s_t_r_i_n_g
  356.             Sets the title for the table-of-contents.
  357.  
  358.  
  359.        --top _m_a_r_g_i_n
  360.             Specifies  the  top  margin  in  points (no suffix or
  361.             ##pt), inches (##in), centimeters (##cm), or millime-
  362.             ters (##mm).
  363.  
  364.  
  365.        --truetype
  366.             Enables use of TrueType fonts in PDF output.
  367.  
  368.  
  369.        --user-password _p_a_s_s_w_o_r_d
  370.             Specifies  the  user  password  for encryption of PDF
  371.             files.
  372.  
  373.  
  374.        --verbose
  375.  
  376.        -v
  377.             Provides verbose messages.
  378.  
  379.  
  380.        --version
  381.             Displays the current version number.
  382.  
  383.  
  384.        --webpage
  385.             Specifies that  the  HTML  sources  are  unstructured
  386.             (plain  web pages.)  A page break is inserted between
  387.             each file or URL in the output.
  388.  
  389.  
  390. HHEEAADDEERR//FFOOOOTTEERR FFOORRMMAATTSS
  391.        The header and footer of each page can contain up to three
  392.        preformatted  values.  These  values are specified using a
  393.        single character for the left, middle, and  right  of  the
  394.        page, resulting in the _f_f_f notation shown previously.
  395.  
  396.        Each character can be one of the following:
  397.  
  398.  
  399.        blank
  400.  
  401.  
  402.        /
  403.             n/N arabic page numbers (1/3, 2/3, 3/3)
  404.  
  405.  
  406.        :
  407.             c/C  arabic chapter page numbers (1/2, 2/2, 1/4, 2/4,
  408.             ...)
  409.  
  410.  
  411.        1
  412.             arabic numbers (1, 2, 3, ...)
  413.  
  414.  
  415.        a
  416.             lowercase letters
  417.  
  418.  
  419.        A
  420.             uppercase letters
  421.  
  422.  
  423.        c
  424.             current chapter heading
  425.  
  426.  
  427.        C
  428.             current chapter page number (arabic)
  429.  
  430.  
  431.        d
  432.             current date
  433.  
  434.  
  435.        D
  436.             current date and time
  437.  
  438.  
  439.        h
  440.             current heading
  441.  
  442.  
  443.        i
  444.             lowercase roman numerals
  445.  
  446.  
  447.        I
  448.             uppercase roman numerals
  449.  
  450.  
  451.        l
  452.             logo image
  453.  
  454.  
  455.        t
  456.             title text
  457.  
  458.  
  459.        T
  460.             current time
  461.  
  462.  
  463. SSEEEE AALLSSOO
  464.        HTMLDOC 1.8.19 Software Users Manual
  465.  
  466.        http://www.easysw.com/htmldoc
  467.  
  468. AAUUTTHHOORR
  469.        Michael Sweet (mike@easysw.com), Easy Software Products
  470.  
  471. TTRRAADDEEMMAARRKKSS
  472.        PostScript is a trademark that may be registered  in  some
  473.        countries  and  Adobe  is  a registered trademark of Adobe
  474.        Systems Incorporated.
  475.  
  476. CCOOPPYYRRIIGGHHTTSS
  477.        Portable Document Format Copyright 1993-1999 by Adobe Sys-
  478.        tems Incorporated.
  479.  
  480.        HTMLDOC  is copyright 1997-2002 by Easy Software Products.
  481.        This program is free software;  you  can  redistribute  it
  482.        and/or modify it under the terms of the GNU General Public
  483.        License as published  by  the  Free  Software  Foundation;
  484.        either  version  2 of the License, or (at your option) any
  485.        later version.
  486.  
  487.        This program is based in part on the work of the  Indepen-
  488.        dent JPEG Group.
  489.  
  490. NNOO WWAARRRRAANNTTYY
  491.        This  program  is  distributed in the hope that it will be
  492.        useful, but WITHOUT ANY WARRANTY; without even the implied
  493.        warranty  of  MERCHANTABILITY  or FITNESS FOR A PARTICULAR
  494.        PURPOSE.  See the GNU  General  Public  License  for  more
  495.        details.
  496.  
  497.  
  498.  
  499. 14 March 2002             HTMLDOC 1.8.19               htmldoc(1)
  500.